home *** CD-ROM | disk | FTP | other *** search
/ Megahits 5 / Megahits 5 (1994)(GTI - Rhein-Main-Soft)(DE)(Disc 2 of 2)[!].iso / archive / show / supervw_lib_82.lha / superview-lib / Programmers / Docs / SVDriver_Ref_ENG.doc < prev    next >
Text File  |  1994-09-10  |  10KB  |  445 lines
  1.  
  2.    $VER: SVDriver_Ref_ENG.doc V1.3 (16.8.94)
  3.  
  4.    © 1994 by Andreas R. Kleinert. All rights reserved.
  5.  
  6.    - Feel free to translate this Doc-File into other languages. -
  7.  
  8.        Andreas R. Kleinert,
  9.        Grube Hohe Grethe 23,
  10.        D-57074 Siegen,
  11.        Germany.                        email : Fido 2:2457/345.10
  12.                                                (checked weekly)
  13.  
  14.    * DO _NEVER_ ACCESS ANY SVDRIVERS DIRECTLY.
  15.    * DO NEVER BYPASS superview.library !
  16.  
  17.    THE FOLLOWING NOTES ARE ONLY FOR PROGRAMMERS OF SVDRIVERS :
  18.  
  19.    Here is a listing of the function set, which any of the version 1
  20.    SVDrivers does contain, in an Autodoc-like style of description :
  21.  
  22.         SVD_AllocHandle            ; since Version 1
  23.         SVD_FreeHandle
  24.         SVD_CloseDisplay
  25.         SVD_FreeResources
  26.         SVD_SetGfxBuffer
  27.         SVD_DisplayGfxBuffer
  28.         SVL_SetScreenType
  29.         SVD_SetWindowFlags
  30.         SVD_SetWindowIDCMP
  31.         SVD_GetScreenAddress
  32.         SVD_GetWindowAddress
  33.  
  34.  (you will never find any notes belonging to "BUGS", because any SVDriver
  35.   may have its own ...)
  36.  
  37. -----------------------------------------------------------------------------
  38.    Functions available since Version 1 :
  39. -----------------------------------------------------------------------------
  40.  
  41.    NAME
  42.         SVD_AllocHandle
  43.  
  44.    SYNOPSIS
  45.  
  46.         APTR SVD_AllocHandle(APTR future)
  47.         D0   -$1e            A1
  48.  
  49.    FUNCTION
  50.  
  51.         Allocates a handle for displaying a GfxBuffer via this SVDriver.
  52.  
  53.    INPUT(S)
  54.  
  55.         future - always NULL yet
  56.  
  57.    RESULT
  58.  
  59.         A pointer to a new allocated Handle or NULL, if allocation failed.
  60.  
  61.    WARNING
  62.  
  63.         Test, if the result was NULL, or not !
  64.  
  65.    SINCE
  66.  
  67.         ... Version 1 SVDrivers.
  68.  
  69.    SEE ALSO
  70.  
  71.         SVD_FreeResources, SVD_FreeHandle
  72.  
  73. -----------------------------------------------------------------------------
  74.  
  75.    NAME
  76.         SVD_FreeHandle
  77.  
  78.    SYNOPSIS
  79.  
  80.         VOID SVD_FreeHandle(APTR handle)
  81.         D0   -$24           A1
  82.  
  83.    FUNCTION
  84.  
  85.        Aborts showing, frees all Resources and delocates a Handle, which has
  86.        been allocated with SVD_AllocHandle before.
  87.  
  88.  
  89.        For programmers of SVDrivers :
  90.  
  91.        Note, that this function should call
  92.  
  93.           SVD_CloseDisplay(SVHandle);
  94.           SVD_FreeResources(SVHandle);
  95.  
  96.        internally always. Otherwise memory might be lost, because
  97.        superview.library might only make a call to SVO_FreeHandle(),
  98.        without closing the display/freeing the resources before.
  99.  
  100.    INPUT(S)
  101.  
  102.         handle - a valid handle
  103.  
  104.    RESULT
  105.  
  106.         -
  107.  
  108.    SINCE
  109.  
  110.         ... Version 1 SVDrivers.
  111.  
  112.    SEE ALSO
  113.  
  114.         SVD_AllocHandle, SVD_CloseDisplay, SVD_FreeResources
  115.  
  116. -----------------------------------------------------------------------------
  117.  
  118.    NAME
  119.         SVD_CloseDisplay
  120.  
  121.    SYNOPSIS
  122.  
  123.         VOID SVD_CloseDisplay(APTR handle)
  124.         D0   -$2a             A1
  125.  
  126.    FUNCTION
  127.  
  128.         Aborts showing the Graphic, indentified by the handle.
  129.         The Display-Screen is closed, but no other resources are given free.
  130.  
  131.    INPUT(S)
  132.  
  133.         handle - a valid handle
  134.  
  135.    RESULT
  136.  
  137.         -
  138.  
  139.    SINCE
  140.  
  141.         ... Version 1 SVDrivers.
  142.  
  143.    SEE ALSO
  144.  
  145.         SVD_FreeResources, SVD_FreeHandle
  146.  
  147. -----------------------------------------------------------------------------
  148.  
  149.    NAME
  150.         SVD_FreeResources
  151.  
  152.    SYNOPSIS
  153.  
  154.         VOID SVD_FreeResources(APTR handle)
  155.         D0   -$30              A1
  156.  
  157.    FUNCTION
  158.  
  159.         Frees all resources belonging to the specific Graphic,
  160.         indentified by the handle, which are not needed to just show it.
  161.         The Display will not be closed.
  162.  
  163.    INPUT(S)
  164.  
  165.         handle - a valid handle
  166.  
  167.    RESULT
  168.  
  169.         -
  170.  
  171.    SINCE
  172.  
  173.         ... Version 1 SVDrivers.
  174.  
  175.    SEE ALSO
  176.  
  177.         SVD_AllocHandle, SVD_CloseDisplay, SVD_FreeHandle
  178.  
  179. -----------------------------------------------------------------------------
  180.  
  181.    NAME
  182.         SVD_SetGfxBuffer
  183.  
  184.    SYNOPSIS
  185.  
  186.         ULONG SVD_SetGfxBuffer(APTR handle, struct SV_GfxBuffer *buffer,
  187.         D0    -$36             A1           A2
  188.  
  189.                                ULONG future)
  190.                                A3
  191.  
  192.    FUNCTION
  193.  
  194.         Initializes the given handle with a pointer to a SV_GfxBuffer, which
  195.         should be used with the next call of SVD_DisplayGfxBuffer (see there).
  196.  
  197.         This Buffer STILL HAS TO BE GIVEN FREE the way it has been allocated
  198.         (see documentation of SVObjects and superviewsupport.library)
  199.         and may still be displayed via SVD_DisplayGfxBuffer or saved
  200.         anywhere else.
  201.  
  202.    INPUT(S)
  203.  
  204.         handle    - a valid handle
  205.         buffer    - a pointer to a valid SV_GfxBuffer
  206.         future    - always NULL yet
  207.  
  208.    RESULT
  209.  
  210.         NULL or an adequate SVERR-Errorcode.
  211.  
  212.    SINCE
  213.  
  214.         ... Version 1 SVDrivers.
  215.  
  216.    SEE ALSO
  217.  
  218.         SVD_DisplayGfxBuffer
  219.  
  220. -----------------------------------------------------------------------------
  221.  
  222.    NAME
  223.         SVD_DisplayGfxBuffer
  224.  
  225.    SYNOPSIS
  226.  
  227.         ULONG SVD_DisplayGfxBuffer(APTR handle, future)
  228.         D0    -$3c                 A1           A2
  229.  
  230.    FUNCTION
  231.  
  232.         Displays the GfxBuffer (which has been set via SVD_SetGfxBuffer before)
  233.         in the way, which is native to this SVDriver (e.g. on an Intuition
  234.         Screen, an EGS-Screen or into NIL ...)
  235.  
  236.    INPUT(S)
  237.  
  238.         handle    - a valid handle
  239.         future    - always NULL yet
  240.  
  241.    RESULT
  242.  
  243.         NULL or an adequate SVERR-Errorcode.
  244.  
  245.    SINCE
  246.  
  247.         ... Version 1 SVDrivers.
  248.  
  249.    SEE ALSO
  250.  
  251.         SVD_SetGfxBuffer
  252.  
  253. -----------------------------------------------------------------------------
  254.  
  255.    NAME
  256.         SVL_SetScreenType
  257.  
  258.    SYNOPSIS
  259.  
  260.         ULONG SVL_SetScreenType(APTR handle, ULONG type, APTR future)
  261.         D0    -$42              A1           D1          A2
  262.  
  263.    FUNCTION
  264.  
  265.         Specifies, which ScreenType the Screen should have, on which the
  266.         graphic is to be displayed later.
  267.  
  268.         This statement may have no effect, if the SVDriver uses non-Intuition
  269.         ways of displaying or exporting the GfxBuffer (e.g. EGS.svdriver will
  270.         ignore this setting more or less).
  271.  
  272.    INPUT(S)
  273.  
  274.         handle - a valid handle
  275.         type   - a ScreenType descriptor, like e.g. CUSTOMSCREEN
  276.         future - always NULL yet
  277.  
  278.    RESULT
  279.  
  280.         NULL or an adequate SVERR-Errorcode.
  281.  
  282.    SINCE
  283.  
  284.         ... Version 1 SVDrivers.
  285.  
  286.    SEE ALSO
  287.  
  288.         SVD_GetScreenAddress
  289.  
  290. -----------------------------------------------------------------------------
  291.  
  292.    NAME
  293.         SVD_SetWindowFlags
  294.  
  295.    SYNOPSIS
  296.  
  297.         ULONG SVD_SetWindowFlags(APTR handle, ULONG flags, APTR future)
  298.         D0    -$48               A1           D1           A2
  299.  
  300.    FUNCTION
  301.  
  302.         Specifies, which Flags the Window should have, on which the
  303.         graphic is to be displayed later.
  304.  
  305.         This statement may have no effect, if the SVDriver uses non-Intuition
  306.         ways of displaying or exporting the GfxBuffer (e.g. EGS.svdriver will
  307.         ignore this setting more or less).
  308.  
  309.    INPUT(S)
  310.  
  311.         handle     - a valid handle
  312.         flags      - valid WindowFlags, like e.g. WFLG_BACKDROP
  313.         future     - always NULL yet
  314.  
  315.    RESULT
  316.  
  317.         NULL or an adequate SVERR-Errorcode.
  318.  
  319.    SINCE
  320.  
  321.         ... Version 1 SVDrivers.
  322.  
  323.    SEE ALSO
  324.  
  325.         SVD_SetWindowIDCMP, SVD_GetWindowAddress
  326.  
  327. -----------------------------------------------------------------------------
  328.  
  329.    NAME
  330.         SVD_SetWindowIDCMP
  331.  
  332.    SYNOPSIS
  333.  
  334.         ULONG SVD_SetWindowIDCMP(APTR handle, ULONG idcmp, APTR future)
  335.         D0    -$4e               A1           D1           A2
  336.  
  337.    FUNCTION
  338.  
  339.         Specifies, which IDCMP the Window should have, on which the
  340.         graphic is to be displayed later.
  341.  
  342.         This statement may have no effect, if the SVDriver uses non-Intuition
  343.         ways of displaying or exporting the GfxBuffer (e.g. EGS.svdriver will
  344.         ignore this setting more or less).
  345.  
  346.    INPUT(S)
  347.  
  348.         handle - a valid handle
  349.         idcmp  - a valid set of IDCMP-Flags
  350.         future - always NULL yet
  351.  
  352.    RESULT
  353.  
  354.         NULL or an adequate SVERR-Errorcode.
  355.  
  356.    SINCE
  357.  
  358.         ... Version 1 SVDrivers.
  359.  
  360.    SEE ALSO
  361.  
  362.         SVD_Show
  363.  
  364. -----------------------------------------------------------------------------
  365.  
  366.    NAME
  367.         SVD_GetScreenAddress
  368.  
  369.    SYNOPSIS
  370.  
  371.         struct Screen *SVD_GetScreenAddress(APTR handle, future)
  372.         D0             -$54                 A1           A2
  373.  
  374.    FUNCTION
  375.  
  376.         While displaying, the address of the DisplayScreen is returned
  377.         by this function.
  378.         See example SourceCodes for more and detailed information.
  379.  
  380.         This statement may not return a pointer to the real DisplayScreen,
  381.         if the SVDriver uses non-Intuition ways of displaying or exporting
  382.         the GfxBuffer (e.g. EGS.svdriver uses EGS-Screens, which are not
  383.         compatible with Intuition Screens).
  384.         So NULL or a pointer to a Dummy-Screen (Workbench-Screen) might be
  385.         returned sometimes.
  386.  
  387.    INPUT(S)
  388.  
  389.         handle - a valid handle
  390.         future - always NULL yet
  391.  
  392.    RESULT
  393.  
  394.         A valid ScreenPointer or NULL.
  395.  
  396.    SINCE
  397.  
  398.         ... Version 1 SVDrivers.
  399.  
  400.    SEE ALSO
  401.  
  402.         SVD_GetWindowAddress
  403.  
  404. -----------------------------------------------------------------------------
  405.  
  406.    NAME
  407.         SVD_GetWindowAddress
  408.  
  409.    SYNOPSIS
  410.  
  411.         struct Window *SVD_GetWindowAddress(APTR handle, future)
  412.         D0             -$5a                 A1           A2
  413.  
  414.    FUNCTION
  415.  
  416.         While displaying, the address of the DisplayWindows is returned
  417.         by this function.
  418.         See example SourceCodes for more and detailed information.
  419.  
  420.         This statement may not return a pointer to the real DisplayWindow,
  421.         if the SVDriver uses non-Intuition ways of displaying or exporting
  422.         the GfxBuffer (e.g. EGS.svdriver uses EGS-Windows, which are not
  423.         compatible with Intuition Windows).
  424.         So NULL or a pointer to a Dummy-Window (Custom-Window on Workbench)
  425.         might be returned sometimes.
  426.  
  427.    INPUT(S)
  428.  
  429.         handle - a valid handle
  430.         future - always NULL yet
  431.  
  432.    RESULT
  433.  
  434.         A valid WindowPointer or NULL.
  435.  
  436.    SINCE
  437.  
  438.         ... Version 1 SVDrivers.
  439.  
  440.    SEE ALSO
  441.  
  442.         SVD_GetScreenAddress
  443.  
  444. -----------------------------------------------------------------------------
  445.